Skip to content

Update CONTRIBUTING.md#7490

Merged
mountiny merged 2 commits into
mainfrom
mallenexpensify-patch-1
Feb 1, 2022
Merged

Update CONTRIBUTING.md#7490
mountiny merged 2 commits into
mainfrom
mallenexpensify-patch-1

Conversation

@mallenexpensify

Copy link
Copy Markdown
Contributor

Added - Please use the templates for bugs and feature requests that are bookmarked in #expensify-open-source.
Removed text about inc. details cuz those are in the template.

Details

Added - Please use the templates for bugs and feature requests that are bookmarked in #expensify-open-source.
Removed text about inc. details cuz those are in the template.

Fixed Issues

$ GH_LINK

Tests

Ensure text reads Please use the templates for bugs and feature requests that are bookmarked in #expensify-open-source.

  • Verify that no errors appear in the JS console

QA Steps

  • Verify that no errors appear in the JS console

Tested On

  • Web
  • Mobile Web
  • Desktop
  • iOS
  • Android

Screenshots

Web

Mobile Web

Desktop

iOS

Android

Added - Please use the templates for bugs and feature requests that are bookmarked in #expensify-open-source.  
Removed text about inc. details cuz those are in the template.
@mallenexpensify mallenexpensify requested a review from a team as a code owner January 31, 2022 23:31
@mallenexpensify mallenexpensify self-assigned this Jan 31, 2022
@MelvinBot MelvinBot requested review from mountiny and removed request for a team January 31, 2022 23:31

@mountiny mountiny left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we maybe include a link to the How to create a plan instruction somewhere in this file too?

@mallenexpensify

Copy link
Copy Markdown
Contributor Author

Yes! Good call @mountiny , can you see where it'd fit best and add it? (it'll be quicker for you, I imagine)

@mountiny mountiny left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left a suggestion there, feel free to adjust it as you find best.

Comment thread CONTRIBUTING.md Outdated
4. If there is no existing GitHub issue or Upwork job, check if the issue is happening on prod (as opposed to only happening on dev)
5. If the issue is just in dev then it means it's a new issue and has not been deployed to production. In this case, you should try to find the offending PR and comment in the issue tied to the PR and ask the assigned users to add the `DeployBlockerCash` label. If you can't find it, follow the reporting instructions in the next item, but note that the issue is a regression only found in dev and not in prod.
6. If the issue happens in production then report the issue(s) in the [#expensify-open-source](https://github.com/Expensify/App/blob/main/CONTRIBUTING.md#asking-questions) Slack channel, prefixed with `BUG:` or `Feature Request:`. Include all relevant data, screenshots and examples in the post or thread.
6. If the issue happens in production then report the issue(s) in the [#expensify-open-source](https://github.com/Expensify/App/blob/main/CONTRIBUTING.md#asking-questions) Slack channel, prefixed with `BUG:` or `Feature Request:`. Please use the templates for bugs and feature requests that are bookmarked in #expensify-open-source.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mallenexpensify To be honest, I believe this line is the best in this file. I feel like the instructions are most handy when someone wants to propose a new feature, which is mentioned on this line. So I suggest:

Suggested change
6. If the issue happens in production then report the issue(s) in the [#expensify-open-source](https://github.com/Expensify/App/blob/main/CONTRIBUTING.md#asking-questions) Slack channel, prefixed with `BUG:` or `Feature Request:`. Please use the templates for bugs and feature requests that are bookmarked in #expensify-open-source.
6. If the issue happens in production then report the issue(s) in the [#expensify-open-source](https://github.com/Expensify/App/blob/main/CONTRIBUTING.md#asking-questions) Slack channel, prefixed with `BUG:` or `Feature Request:`. Please use the templates for bugs and feature requests that are bookmarked in #expensify-open-source. For instructions on how to come up with a plan, which could be useful for you in this stage especially in case of a feature request, please refer to [this guide](https://github.com/Expensify/App/blob/main/HOW_TO_CREATE_A_PLAN.md).

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mountiny , this shortened version will likely work better.

View this guide for help creating a plan when proposing a feature request

How would I delete yours and add mine above? I'm unfamiliar with editing a PR

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mallenexpensify I think what you can do is to click on the branch name here:
image

mallenexpensify-patch-1 in this case. That will bring you to your version of the code which we can see in this PR. Then navigate to the Contributing file https://github.com/Expensify/App/blob/mallenexpensify-patch-1/CONTRIBUTING.md

And then you cum click the pencil button same as before, make the changes and commit it.

@mallenexpensify

Copy link
Copy Markdown
Contributor Author

Thanks @mountiny , that gets me to the edit page but I don't see your proposed changes there to edit
image

Would I just make the intended final edits there then Github would use 'magic' to decipher the differences between your recommended updates and mine?

@mountiny

mountiny commented Feb 1, 2022

Copy link
Copy Markdown
Contributor

@mallenexpensify That is correct, what you will see there are only the changes you have made. You can then copy this line and put it in there and in the bottom add commit and it will show up here!

View [this guide](https://github.com/Expensify/App/blob/main/HOW_TO_CREATE_A_PLAN.md) for help creating a plan when proposing a feature request.

> View [this guide](https://github.com/Expensify/App/blob/main/HOW_TO_CREATE_A_PLAN.md) for help creating a plan when proposing a feature request.
@mallenexpensify

Copy link
Copy Markdown
Contributor Author

I did what you recommended above @mountiny , should it show up here now?

@mountiny mountiny left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes! Amazing! You can see in the top header menu in the PR that there are 2 commits.
image
Jut gonna wait for the tests.

@mountiny mountiny merged commit 0fe464f into main Feb 1, 2022
@mountiny mountiny deleted the mallenexpensify-patch-1 branch February 1, 2022 17:47
@botify

botify commented Feb 1, 2022

Copy link
Copy Markdown

@mountiny looks like this was merged without passing tests. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

@OSBotify

OSBotify commented Feb 1, 2022

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by @mountiny in version: 1.1.33-5 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 failure ❌
🕸 web 🕸 success ✅

@OSBotify

OSBotify commented Feb 2, 2022

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by @sketchydroide in version: 1.1.34-0 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 web 🕸 success ✅

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants